Read
==========

This page contains the documentation for 'read.py'. This module provides functions to read single or multi-detector injection files, load glitches and gravitational waves, and return the time series data.

Function Definitions
----------------------

.. raw:: html

   <div class="function-box">
   <strong>GlitchPop.read.single_ifo(file_name)</strong>
   </div>

Reads a single IFO injection file with glitches and gravitational waves. This should only be used if reading files not generated from the tri-dector simulators.

**Parameters:**

- **file_name** (string) - Name of the .json injection file

**Returns:**

- **gwpy.timeseries.TimeSeries** - Strain `h(t)` loaded from the injection file

.. raw:: html

   <div class="function-box">
   <strong>GlitchPop.read.tri_ifo(file_name)</strong>
   </div>

Reads a multi-detector injection file with glitches and gravitational waves. The multi-detector reader should be used to perserve the gravitational wave time offset between different detectors in the tri-detector simulations. If it is not used for reading tri-dector simulations, the gravitional wave signals will all have the same merger time across the network.

**Parameters:**

- **file_name** (string) - Name of the .json injection file

**Returns:**

- **gwpy.timeseries.TimeSeries** - Strain `h(t)` loaded from the injection file